home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xi / XSendExtensionEvent.z / XSendExtensionEvent
Encoding:
Text File  |  2002-10-03  |  7.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeennnnddddEEEExxxxtttteeeennnnssssiiiioooonnnnEEEEvvvveeeennnntttt((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeennnnddddEEEExxxxtttteeeennnnssssiiiioooonnnnEEEEvvvveeeennnntttt((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSendExtensionEvent - send input extension events to a
  10.           client
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           Status XSendExtensionEvent(_d_i_s_p_l_a_y, _d_e_v_i_c_e, _d_e_s_t_i_n_a_t_i_o_n,
  14.           _p_r_o_p_a_g_a_t_e, _e_v_e_n_t__c_o_u_n_t, _e_v_e_n_t__l_i_s_t, _e_v_e_n_t__s_e_n_d)
  15.                 Display *_d_i_s_p_l_a_y;
  16.                 XDevice *_d_e_v_i_c_e;
  17.                 Window _d_e_s_t_i_n_a_t_i_o_n;
  18.                 Bool _p_r_o_p_a_g_a_t_e;
  19.                 int _e_v_e_n_t__c_o_u_n_t;
  20.                 XEventClass *_e_v_e_n_t__l_i_s_t;
  21.                 XEvent *_e_v_e_n_t__s_e_n_d;
  22.  
  23.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  24.           _d_i_s_p_l_a_y     Specifies the connection to the X server.
  25.  
  26.           _d_e_v_i_c_e      Specifies the device from which the events are
  27.                       to be sent.
  28.  
  29.           _d_e_s_t_i_n_a_t_i_o_n Specifies the window the event is to be sent to.
  30.                       You can pass window id, _P_o_i_n_t_e_r_W_i_n_d_o_w, or
  31.                       _I_n_p_u_t_F_o_c_u_s.
  32.  
  33.           _p_r_o_p_a_g_a_t_e   Specifies a Boolean value that is either True or
  34.                       False.
  35.  
  36.           _e_v_e_n_t__c_o_u_n_t Specifies the count of XEventClasses in
  37.                       event_list.
  38.  
  39.           _e_v_e_n_t__l_i_s_t  Specifies the list of event selections to be
  40.                       used.
  41.  
  42.           _e_v_e_n_t__s_e_n_d  Specifies a pointer to the event that is to be
  43.                       sent.
  44.  
  45.           The _X_S_e_n_d_E_x_t_e_n_s_i_o_n_E_v_e_n_t request identifies the destination
  46.           window, determines which clients should receive the
  47.           specified events, and ignores any active grabs.  This
  48.           request requires you to pass an event class list.  For a
  49.           discussion of the valid event class names, see
  50.           _X_O_p_e_n_D_e_v_i_c_e(_3_X_1_1).  This request uses the w argument to
  51.           identify the destination window as follows:
  52.  
  53.           +o    If w is _P_o_i_n_t_e_r_W_i_n_d_o_w , the destination window is the
  54.                window that contains the pointer.
  55.  
  56.           +o    If w is _I_n_p_u_t_F_o_c_u_s and if the focus window contains the
  57.                pointer, the destination window is the window that
  58.                contains the pointer; otherwise, the destination window
  59.                is the focus window.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeennnnddddEEEExxxxtttteeeennnnssssiiiioooonnnnEEEEvvvveeeennnntttt((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeennnnddddEEEExxxxtttteeeennnnssssiiiioooonnnnEEEEvvvveeeennnntttt((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           To determine which clients should receive the specified
  75.           events, _X_S_e_n_d_E_x_t_e_n_s_i_o_n_E_v_e_n_t uses the propagate argument as
  76.           follows:
  77.  
  78.           +o    If event_list is the empty set, the event is sent to
  79.                the client that created the destination window.  If
  80.                that client no longer exists, no event is sent.
  81.  
  82.           +o    If propagate is _F_a_l_s_e, the event is sent to every
  83.                client selecting on destination any of the event types
  84.                specified by the event_list array.
  85.  
  86.           +o    If propagate is _T_r_u_e and no clients have selected on
  87.                destination any of the events specified by the
  88.                event_list array, the destination is replaced with the
  89.                closest ancestor of destination for which some client
  90.                has selected a type specified by the event-list array
  91.                and for which no intervening window has that type in
  92.                its do-not-propagate-mask. If no such window exists or
  93.                if the window is an ancestor of the focus window and
  94.                _I_n_p_u_t_F_o_c_u_s was originally specified as the destination,
  95.                the event is not sent to any clients.  Otherwise, the
  96.                event is reported to every client selecting on the
  97.                final destination any of the events specified in the
  98.                event_list array.
  99.  
  100.           The event in the _X_E_v_e_n_t structure must be one of the events
  101.           defined by the input extension (or a _B_a_d_V_a_l_u_e error results)
  102.           so that the X server can correctly byte-swap the contents as
  103.           necessary. The contents of the event are otherwise unaltered
  104.           and unchecked by the X server except to force send_event to
  105.           _T_r_u_e in the forwarded event and to set the serial number in
  106.           the event correctly.
  107.  
  108.           _X_S_e_n_d_E_x_t_e_n_s_i_o_n_E_v_e_n_t returns zero if the conversion to wire
  109.           protocol format failed and returns nonzero otherwise.
  110.           _X_S_e_n_d_E_x_t_e_n_s_i_o_n_E_v_e_n_t can generate _B_a_d_C_l_a_s_s, _B_a_d_D_e_v_i_c_e,
  111.           _B_a_d_V_a_l_u_e, and _B_a_d_W_i_n_d_o_w errors.
  112.  
  113.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  114.           _B_a_d_D_e_v_i_c_e   An invalid device was specified.  The specified
  115.                       device does not exist or has not been opened by
  116.                       this client via _X_O_p_e_n_I_n_p_u_t_D_e_v_i_c_e.  This error
  117.                       may also occur if the specified device is the X
  118.                       keyboard or X pointer device.
  119.  
  120.           _B_a_d_V_a_l_u_e    Some numeric value falls outside the range of
  121.                       values accepted by the request.  Unless a
  122.                       specific range is specified for an argument, the
  123.                       full range defined by the argument's type is
  124.                       accepted.  Any argument defined as a set of
  125.                       alternatives can generate this error.
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSeeeennnnddddEEEExxxxtttteeeennnnssssiiiioooonnnnEEEEvvvveeeennnntttt((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXSSSSeeeennnnddddEEEExxxxtttteeeennnnssssiiiioooonnnnEEEEvvvveeeennnntttt((((3333XXXX11111111))))
  137.  
  138.  
  139.  
  140.           _B_a_d_W_i_n_d_o_w   A value for a Window argument does not name a
  141.                       defined Window.
  142.  
  143.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  144.           _P_r_o_g_r_a_m_m_i_n_g _w_i_t_h _X_l_i_b
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.